<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>bram: xbram_intr_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">bram
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xbram__intr__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xbram_intr_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the BRAM driver (<a class="el" href="struct_x_bram.html" title="The XBram driver instance data. ">XBram</a>) in an interrupt driven mode of operation. </p>
<p>This example assumes that there is an interrupt controller in the hardware system and the BRAM device is connected to the interrupt controller.</p>
<pre>
 MODIFICATION HISTORY:</pre><pre> Ver   Who  Date         Changes
</p>
<hr/>
<p>
 1.00a sa   05/11/10 Initial release.
 3.01a sa   13/01/12 Changed XBram_SelfTest(InstancePtr) to
                         XBram_SelfTest(InstancePtr, XBRAM_IR_ALL_MASK)
                         as per new API (CR 639274)
 4.1   ms   01/23/17 Modified xil_printf statement in main function to
                     ensure that "Successfully ran" and "Failed" strings are
                     available in all examples. This is a fix for CR-965028.
 4.7   mus  08/25/21 BRAM and interrupt controller instance need not to be
                     declared in case of peripheral test, added condition to skip
                     them in case of peripheral test (CR#1108877)
 4.9   sd   07/07/23 Added SDT support.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a02808f594e2c936129bed18559bc0e97"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xbram__intr__example_8c.html#a02808f594e2c936129bed18559bc0e97">BramIntrExample</a> (XIntc *IntcInstancePtr, <a class="el" href="struct_x_bram.html">XBram</a> *InstancePtr, u16 DeviceId, u16 IntrId)</td></tr>
<tr class="memdesc:a02808f594e2c936129bed18559bc0e97"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the entry function from the TestAppGen tool generated application which tests the interrupts when enabled in the BRAM.  <a href="#a02808f594e2c936129bed18559bc0e97">More...</a><br/></td></tr>
<tr class="separator:a02808f594e2c936129bed18559bc0e97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xbram__intr__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the main function of the BRAM example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a02808f594e2c936129bed18559bc0e97"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int BramIntrExample </td>
          <td>(</td>
          <td class="paramtype">XIntc *&#160;</td>
          <td class="paramname"><em>IntcInstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_bram.html">XBram</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>IntrId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is the entry function from the TestAppGen tool generated application which tests the interrupts when enabled in the BRAM. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">IntcInstancePtr</td><td>is a reference to the Interrupt Controller driver Instance </td></tr>
    <tr><td class="paramname">InstancePtr</td><td>is a reference to the BRAM driver Instance </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is the XPAR_&lt;BRAM_instance&gt;_DEVICE_ID value from xparameters.h </td></tr>
    <tr><td class="paramname">IntrId</td><td>is XPAR_&lt;INTC_instance&gt;_&lt;BRAM_instance&gt;_VEC_ID value from xparameters.h</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the example is successful.</li>
<li>XST_FAILURE if the example failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_bram___config.html#ae96ce11672cf82713b994dc80a1a05aa">XBram_Config::CtrlBaseAddress</a>, <a class="el" href="struct_x_bram___config.html#ac12c18f690cc9dbc18392ee8c01c29d7">XBram_Config::EccStatusInterruptPresent</a>, <a class="el" href="struct_x_bram___config.html#a58c670c0f23257fa4521b4fc219773bc">XBram_Config::FaultInjectionPresent</a>, <a class="el" href="struct_x_bram___config.html#a33d6e8224ae0b1a661e4c2dad194377c">XBram_Config::UncorrectableFailingDataRegs</a>, <a class="el" href="group__bram.html#gab305438b0844ddb20139878c21ef0e6b">XBram_CfgInitialize()</a>, <a class="el" href="group__bram.html#ga8b01c0b7cae31073a32887283a730adf">XBRAM_IR_ALL_MASK</a>, <a class="el" href="group__bram.html#gab4bacc0667e96732958979264a8a1296">XBram_LookupConfig()</a>, and <a class="el" href="group__bram.html#gaedbdefb6cda5c212f03271143ccf7a98">XBram_SelfTest()</a>.</p>

<p>Referenced by <a class="el" href="xbram__intr__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the main function of the BRAM example. </p>
<p>It is for initializing the BRAM device and setting up interrupts.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS to indicate success.</li>
<li>XST_FAILURE to indicate failure.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xbram__intr__example_8c.html#a02808f594e2c936129bed18559bc0e97">BramIntrExample()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
